home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 2000 April: Mac OS SDK / Dev.CD Apr 00 SDK1.toast / Development Kits / Mac OS / UPDATE- Int&Libs 3.2 / AIncludes / URLAccess.a < prev   
Encoding:
Text File  |  1999-05-25  |  7.9 KB  |  279 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        URLAccess.a
  3. ;
  4. ;    Contains:    URL Access Interfaces.
  5. ;
  6. ;    Version:    Technology:    1.0
  7. ;                Release:    Veronica Seed, Use with 3.2 Universal Interfaces
  8. ;
  9. ;    Copyright:    © 1994-1999 by Apple Computer, Inc., all rights reserved
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__URLACCESS__') = 'UNDEFINED' THEN
  18. __URLACCESS__ SET 1
  19.  
  20.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  21.     include 'Types.a'
  22.     ENDIF
  23.     IF &TYPE('__FILES__') = 'UNDEFINED' THEN
  24.     include 'Files.a'
  25.     ENDIF
  26.     IF &TYPE('__CODEFRAGMENTS__') = 'UNDEFINED' THEN
  27.     include 'CodeFragments.a'
  28.     ENDIF
  29.  
  30. ;  Data structures and types 
  31.  
  32.  
  33.  
  34.  
  35. kURLReplaceExistingFlag            EQU        $01
  36. kURLBinHexFileFlag                EQU        $02                    ; Binhex before uploading if necessary
  37. kURLExpandFileFlag                EQU        $04                    ; Use StuffIt engine to expand file if necessary
  38. kURLDisplayProgressFlag            EQU        $08
  39. kURLDisplayAuthFlag                EQU        $10                    ; Display auth dialog if guest connection fails
  40. kURLUploadFlag                    EQU        $20                    ; Do an upload instead of a download
  41. kURLIsDirectoryHintFlag            EQU        $40                    ; Hint: the URL is a directory
  42. kURLDoNotTryAnonymousFlag        EQU        $80                    ; Don't try to connect anonymously before getting logon info
  43. kURLDirectoryListingFlag        EQU        $0100                ; Download the directory listing, not the whole directory
  44. kURLReservedFlag                EQU        $80000000            ; reserved for Apple internal use
  45. ; typedef UInt32                         URLOpenFlags
  46.  
  47.  
  48. kURLNullState                    EQU        0
  49. kURLInitiatingState                EQU        1
  50. kURLLookingUpHostState            EQU        2                    ; NOT IN EXT HEADER
  51. kURLConnectingState                EQU        3                    ; NOT IN EXT HEADER
  52. kURLResourceFoundState            EQU        4
  53. kURLDownloadingState            EQU        5
  54. kURLDataAvailableState            EQU        $15
  55. kURLTransactionCompleteState    EQU        6
  56. kURLErrorOccurredState            EQU        7
  57. kURLAbortingState                EQU        8
  58. kURLCompletedState                EQU        9
  59. kURLUploadingState                EQU        10
  60. ; typedef UInt32                         URLState
  61.  
  62.  
  63. kURLInitiatedEvent                EQU        1
  64. kURLResourceFoundEvent            EQU        4
  65. kURLDownloadingEvent            EQU        5
  66. kURLAbortInitiatedEvent            EQU        8
  67. kURLCompletedEvent                EQU        9
  68. kURLErrorOccurredEvent            EQU        7
  69. kURLDataAvailableEvent            EQU        $15
  70. kURLTransactionCompleteEvent    EQU        6
  71. kURLUploadingEvent                EQU        10
  72. kURLSystemEvent                    EQU        29
  73. kURLPercentEvent                EQU        30
  74. kURLPeriodicEvent                EQU        31
  75. kURLPropertyChangedEvent        EQU        32
  76. ; typedef UInt32                         URLEvent
  77.  
  78.  
  79. kURLInitiatedEventMask            EQU        $01
  80. kURLResourceFoundEventMask        EQU        $08
  81. kURLDownloadingMask                EQU        $10
  82. kURLUploadingMask                EQU        $0200
  83. kURLAbortInitiatedMask            EQU        $80
  84. kURLCompletedEventMask            EQU        $0100
  85. kURLErrorOccurredEventMask        EQU        $40
  86. kURLDataAvailableEventMask        EQU        $00100000
  87. kURLTransactionCompleteEventMask EQU    $20
  88. kURLSystemEventMask                EQU        $10000000
  89. kURLPercentEventMask            EQU        $20000000
  90. kURLPeriodicEventMask            EQU        $40000000
  91. kURLPropertyChangedEventMask    EQU        $80000000
  92. kURLAllBufferEventsMask            EQU        $00100020
  93. kURLAllNonBufferEventsMask        EQU        $E00003D1
  94. kURLAllEventsMask                EQU        $FFFFFFFF
  95. ; typedef UInt32                         URLEventMask
  96.  
  97. URLCallbackInfo            RECORD 0
  98. version                     ds.l    1                ; offset: $0 (0)
  99. urlRef                     ds.l    1                ; offset: $4 (4)
  100. property                 ds.l    1                ; offset: $8 (8)
  101. currentSize                 ds.l    1                ; offset: $C (12)
  102. systemEvent                 ds.l    1                ; offset: $10 (16)
  103. sizeof                     EQU *                    ; size:   $14 (20)
  104.                         ENDR
  105. ;  http and https properties
  106. ;  authentication type flags
  107.  
  108. kUserNameAndPasswordFlag        EQU        $00000001
  109. ;
  110. ; pascal OSStatus URLGetURLAccessVersion(UInt32 *returnVers)
  111. ;
  112.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  113.         IMPORT_CFM_FUNCTION URLGetURLAccessVersion
  114.     ENDIF
  115.  
  116.     IF TARGET_RT_MAC_CFM THEN
  117. ; 
  118. ;        URLAccessAvailable() is a macro/inline available only in C/C++.  
  119. ;        To get the same functionality from pascal or assembly, you need
  120. ;        to test if URLGetURLAccessVersion function is not NULL.  For instance:
  121. ;        
  122. ;            gURLAccessAvailable = FALSE;
  123. ;            IF @URLAccessAvailable <> kUnresolvedCFragSymbolAddress THEN
  124. ;                gURLAccessAvailable = TRUE;
  125. ;            END
  126. ;    
  127. ;    
  128.  
  129.     ENDIF    ; TARGET_RT_MAC_CFM
  130. ;
  131. ; pascal OSStatus URLSimpleDownload(const char *url, FSSpec *destination, Handle destinationHandle, URLOpenFlags openFlags, URLSystemEventProcPtr eventProc, void *userContext)
  132. ;
  133.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  134.         IMPORT_CFM_FUNCTION URLSimpleDownload
  135.     ENDIF
  136.  
  137. ;
  138. ; pascal OSStatus URLDownload(URLReference urlRef, FSSpec *destination, Handle destinationHandle, URLOpenFlags openFlags, URLSystemEventProcPtr eventProc, void *userContext)
  139. ;
  140.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  141.         IMPORT_CFM_FUNCTION URLDownload
  142.     ENDIF
  143.  
  144. ;
  145. ; pascal OSStatus URLSimpleUpload(const char *url, const FSSpec *source, URLOpenFlags openFlags, URLSystemEventProcPtr eventProc, void *userContext)
  146. ;
  147.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  148.         IMPORT_CFM_FUNCTION URLSimpleUpload
  149.     ENDIF
  150.  
  151. ;
  152. ; pascal OSStatus URLUpload(URLReference urlRef, const FSSpec *source, URLOpenFlags openFlags, URLSystemEventProcPtr eventProc, void *userContext)
  153. ;
  154.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  155.         IMPORT_CFM_FUNCTION URLUpload
  156.     ENDIF
  157.  
  158. ;
  159. ; pascal OSStatus URLNewReference(const char *url, URLReference *urlRef)
  160. ;
  161.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  162.         IMPORT_CFM_FUNCTION URLNewReference
  163.     ENDIF
  164.  
  165. ;
  166. ; pascal OSStatus URLDisposeReference(URLReference urlRef)
  167. ;
  168.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  169.         IMPORT_CFM_FUNCTION URLDisposeReference
  170.     ENDIF
  171.  
  172. ;
  173. ; pascal OSStatus URLOpen(URLReference urlRef, FSSpec *fileSpec, URLOpenFlags openFlags, URLNotifyProcPtr notifyProc, URLEventMask eventRegister, void *userContext)
  174. ;
  175.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  176.         IMPORT_CFM_FUNCTION URLOpen
  177.     ENDIF
  178.  
  179. ;
  180. ; pascal OSStatus URLAbort(URLReference urlRef)
  181. ;
  182.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  183.         IMPORT_CFM_FUNCTION URLAbort
  184.     ENDIF
  185.  
  186. ;
  187. ; pascal OSStatus URLGetDataAvailable(URLReference urlRef, Size *dataSize)
  188. ;
  189.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  190.         IMPORT_CFM_FUNCTION URLGetDataAvailable
  191.     ENDIF
  192.  
  193. ;
  194. ; pascal OSStatus URLGetBuffer(URLReference urlRef, void **buffer, Size *bufferSize)
  195. ;
  196.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  197.         IMPORT_CFM_FUNCTION URLGetBuffer
  198.     ENDIF
  199.  
  200. ;
  201. ; pascal OSStatus URLReleaseBuffer(URLReference urlRef, void *buffer)
  202. ;
  203.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  204.         IMPORT_CFM_FUNCTION URLReleaseBuffer
  205.     ENDIF
  206.  
  207. ;
  208. ; pascal OSStatus URLGetProperty(URLReference urlRef, const char *property, void *propertyBuffer, Size bufferSize)
  209. ;
  210.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  211.         IMPORT_CFM_FUNCTION URLGetProperty
  212.     ENDIF
  213.  
  214. ;
  215. ; pascal OSStatus URLGetPropertySize(URLReference urlRef, const char *property, Size *propertySize)
  216. ;
  217.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  218.         IMPORT_CFM_FUNCTION URLGetPropertySize
  219.     ENDIF
  220.  
  221. ;
  222. ; pascal OSStatus URLSetProperty(URLReference urlRef, const char *property, void *propertyBuffer, Size bufferSize)
  223. ;
  224.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  225.         IMPORT_CFM_FUNCTION URLSetProperty
  226.     ENDIF
  227.  
  228. ;
  229. ; pascal OSStatus URLGetCurrentState(URLReference urlRef, URLState *state)
  230. ;
  231.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  232.         IMPORT_CFM_FUNCTION URLGetCurrentState
  233.     ENDIF
  234.  
  235. ;
  236. ; pascal OSStatus URLGetError(URLReference urlRef, OSStatus *urlError)
  237. ;
  238.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  239.         IMPORT_CFM_FUNCTION URLGetError
  240.     ENDIF
  241.  
  242.  
  243. ;
  244. ; pascal OSStatus URLIdle(void)
  245. ;
  246.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  247.         IMPORT_CFM_FUNCTION URLIdle
  248.     ENDIF
  249.  
  250. ;
  251. ; pascal OSStatus URLGetFileInfo(StringPtr fName, OSType *fType, OSType *fCreator)
  252. ;
  253.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  254.         IMPORT_CFM_FUNCTION URLGetFileInfo
  255.     ENDIF
  256.  
  257.  
  258. ;  Error Codes 
  259.  
  260. kURLInternetAccessErrorCodeBase    EQU        -30770
  261. kURLInvalidURLReferenceError    EQU        -30770
  262. kURLProgressAlreadyDisplayedError EQU    -30771
  263. kURLDestinationExistsError        EQU        -30772
  264. kURLInvalidURLError                EQU        -30773
  265. kURLUnsupportedSchemeError        EQU        -30774
  266. kURLServerBusyError                EQU        -30775
  267. kURLAuthenticationError            EQU        -30776
  268. kURLPropertyNotYetKnownError    EQU        -30777
  269. kURLUnknownPropertyError        EQU        -30778
  270. kURLPropertyBufferTooSmallError    EQU        -30779
  271. kURLUnsettablePropertyError        EQU        -30780
  272. kURLInvalidCallError            EQU        -30781
  273. kURLFileEmptyError                EQU        -30783
  274. kURLExtensionFailureError        EQU        -30785
  275. kURLInvalidConfigurationError    EQU        -30786
  276. kURLAccessNotAvailableError        EQU        -30787
  277.     ENDIF ; __URLACCESS__ 
  278.  
  279.